Inside Macintosh: 3D Graphics Programming With QuickDraw 3D /

Chapter 17 - File Objects / File Objects Reference

File Objects Routines / Reading and Writing File Data

Q3String_Read

You can use the Q3String_Read function to read a string from a file object.

TQ3Status Q3String_Read (
char *data, 
unsigned long *length, 
TQ3FileObject file);

data

On entry, a pointer to a buffer whose length is of size kQ3StringMaximumLength, or NULL. On exit, a pointer to the string read from the specified file object. If this parameter is set to NULL on entry, no string is read, but its length is returned in the length parameter.

length

On exit, the number of characters actually copied into the specified buffer. If data is set to NULL on entry, this parameter returns the length of the string.

file

A file object.

DESCRIPTION

The Q3String_Read function returns, in the data parameter, a pointer to the next string in the file object specified by the file parameter. The string data is 7-bit ASCII, with standard escape sequences for any special characters in the string. The Q3String_Read function also returns, in the length parameter, the length of the string.